<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>CruiseControl.NET : Default Labeller</title>
	    <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">	    
    </head>

    <body>
	    <table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
		    <tr>
			    <td valign="top" class="pagebody">
				    <div class="pageheader">
					    <span class="pagetitle">
                            CruiseControl.NET : Default Labeller
                                                    </span>
				    </div>
				    <div class="pagesubheading">
					    This page last changed on Jul 01, 2009 by <font color="#0050B2">csut017</font>.
				    </div>

				    <h3><a name="DefaultLabeller-DefaultLabeller"></a>Default Labeller</h3>

<p>By default, CCNet uses a plain incrementing build number as a build label. Some source controls (e.g. <a href="Perforce Source Control Block.html" title="Perforce Source Control Block">Perforce Source Control Block</a>) require you to use a different naming scheme if you want CCNet to apply labels to source control on successful builds.<br/>
You can do this by specifying your own configuration of the default labeller in your project.<br/>
The following configuration would prefix all labels with the string 'Foo-1-', so the 213th build would be labelled 'Foo-1-00213'.<br/>
The 2 leading zeros come from the labelFormat, this is set to a length of 5.
<br clear="all" />
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml"><span class="code-tag">&lt;project&gt;</span>
   <span class="code-tag">&lt;labeller type=<span class="code-quote">"defaultlabeller"</span>&gt;</span>
     <span class="code-tag">&lt;initialBuildLabel&gt;</span>1<span class="code-tag">&lt;/initialBuildLabel&gt;</span>
     <span class="code-tag">&lt;prefix&gt;</span>Foo-1-<span class="code-tag">&lt;/prefix&gt;</span>
     <span class="code-tag">&lt;incrementOnFailure&gt;</span>true<span class="code-tag">&lt;/incrementOnFailure&gt;</span>
     <span class="code-tag">&lt;labelFormat&gt;</span>00000<span class="code-tag">&lt;/labelFormat&gt;</span>
   <span class="code-tag">&lt;/labeller&gt;</span>
   <span class="code-tag"><span class="code-comment">&lt;!-- Other project configuration to go here --&gt;</span></span>
<span class="code-tag">&lt;/project&gt;</span></pre>
</div></div><br clear="all" />
<br clear="all" /></p>
<h3><a name="DefaultLabeller-ConfigurationElements%3A"></a>Configuration Elements:</h3>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Node </th>
<th class='confluenceTh'> Description </th>
<th class='confluenceTh'> Type </th>
<th class='confluenceTh'> Required </th>
<th class='confluenceTh'> Default </th>
<th class='confluenceTh'> Version </th>
</tr>
<tr>
<td class='confluenceTd'> initialBuildLabel </td>
<td class='confluenceTd'> Allows you to set the initial build number. (Added in CCNet 1.5) </td>
<td class='confluenceTd'> integer </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> 1 </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> prefix </td>
<td class='confluenceTd'> Any string to be put in front of all labels </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> "" </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> postfix <br clear="all" /> </td>
<td class='confluenceTd'> Any string to be put at the end of all labels </td>
<td class='confluenceTd'> string <br clear="all" /> </td>
<td class='confluenceTd'> false <br clear="all" /> </td>
<td class='confluenceTd'> "" <br clear="all" /> </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> incrementOnFailure </td>
<td class='confluenceTd'> If true, the label will be incremented even if the build fails.  Otherwise it will only be incremented if the build succeeds. </td>
<td class='confluenceTd'> string </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> labelFormat </td>
<td class='confluenceTd'> A format applied to the buildnumber. </td>
<td class='confluenceTd'> string <br clear="all" /> </td>
<td class='confluenceTd'> false </td>
<td class='confluenceTd'> 0 <br clear="all" /> </td>
<td class='confluenceTd'>&nbsp;</td>
</tr>
<tr>
<td class='confluenceTd'> dynamicValues </td>
<td class='confluenceTd'> Any dynamic parameters to be used. See <a href="Dynamic Parameters.html" title="Dynamic Parameters">Dynamic Parameters</a> </td>
<td class='confluenceTd'> Dynamic values array - see <a href="Dynamic Parameters.html" title="Dynamic Parameters">Dynamic Parameters</a> </td>
<td class='confluenceTd'> No </td>
<td class='confluenceTd'> <em>None</em> </td>
<td class='confluenceTd'> 1.5.0 </td>
</tr>
</tbody></table>

				    
                    			    </td>
		    </tr>
	    </table>
	    <table border="0" cellpadding="0" cellspacing="0" width="100%">
			<tr>
				<td height="12" background="http://confluence.public.thoughtworks.org//images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
			</tr>
		    <tr>
			    <td align="center"><font color="grey">Document generated by Confluence on Sep 29, 2009 20:59</font></td>
		    </tr>
	    </table>
    </body>
</html>